UpdateAlias

UpdateAlias
Header:	Aliases.h		Carbon status:	Supported

Updates an alias record.

OSErr UpdateAlias (
    ConstFSSpecPtr fromFile, 
    const FSSpec *target, 
    AliasHandle alias, 
    Boolean *wasChanged
);

fromFile: The starting point for a relative path, to be used later in a relative search. If you do not need relative path information in the record, pass a fromFile value of NULL. If you want UpdateAlias to record relative path information, pass a pointer to a valid FSSpec record in this parameter.
target: The target of the alias record. This parameter must be a valid FSSpec record.
alias: A handle to the alias record to be updated.
wasChanged: A Boolean value indicating whether the newly constructed alias record is exactly the same as the old one. If the new record is the same as the old one, UpdateAlias sets the wasChanged parameter to false. Otherwise, it sets it to true. Check this parameter to determine whether you need to save an updated record.

function result: A result code.

DISCUSSION

The UpdateAlias function rebuilds the entire alias record and fills it in as the NewAlias function would.

The UpdateAlias function always creates a complete alias record. When you use UpdateAlias to update a minimal alias record, you convert the minimal record to a complete record.

SPECIAL CONSIDERATIONS

The two files or directories, fromFile and target, must reside on the same volume.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when InterfaceLib 7.1 or later is installed. Exported by CarbonLib 1.0 and later and by InterfaceLib 7.1 and later.